Skip to main content
GET
/
dashboard
Get dashboard data
curl --request GET \
  --url https://your_a2_service/dashboard \
  --header 'Authorization: Bearer <token>'
{
  "change_allocations": 0,
  "change_campaigns": 0,
  "change_clicks": 0,
  "change_conversions": 0,
  "change_creatives": 0,
  "change_impressions": 0,
  "change_placements": 0,
  "email": "<string>",
  "from_date": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "role": "advertiser",
  "total_advertisers": 0,
  "total_allocations": 0,
  "total_campaigns": 0,
  "total_clicks": 0,
  "total_conversions": 0,
  "total_creatives": 0,
  "total_impressions": 0,
  "total_placements": 0,
  "total_retailers": 0
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
from_date
string<date-time>

Response

Successful Response

Schema for dashboard entity.

​
email
string
required

The email of the query user.

​
from_date
string<date-time>
required
​
role
enum<string>
required

User role enum.

Available options:
advertiser,
retailer,
admin
​
change_allocations
number
default:0

Percentage change in number of allocations compared to previous period.

​
change_campaigns
number
default:0

Percentage change in number of campaigns compared to previous period.

​
change_clicks
number
default:0

Percentage change in number of clicks compared to previous period.

​
change_conversions
number
default:0

Percentage change in number of conversions compared to previous period.

​
change_creatives
number
default:0

Percentage change in number of creatives compared to previous period.

​
change_impressions
number
default:0

Percentage change in number of impressions compared to previous period.

​
change_placements
number
default:0

Percentage change in number of placements compared to previous period.

​
name
string | null

The name of the query user.

​
total_advertisers
integer
default:0

Total number of advertisers.

Required range: x >= 0
​
total_allocations
integer
default:0

Total number of allocations.

Required range: x >= 0
​
total_campaigns
integer
default:0

Total number of campaigns.

Required range: x >= 0
​
total_clicks
integer
default:0

Total number of clicks.

Required range: x >= 0
​
total_conversions
integer
default:0

Total number of conversions.

Required range: x >= 0
​
total_creatives
integer
default:0

Total number of creatives.

Required range: x >= 0
​
total_impressions
integer
default:0

Total number of impressions.

Required range: x >= 0
​
total_placements
integer
default:0

Total number of placements.

Required range: x >= 0
​
total_retailers
integer
default:0

Total number of retailers.

Required range: x >= 0